home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / apr_sha1.h.z / apr_sha1.h
C/C++ Source or Header  |  2002-07-08  |  6KB  |  159 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * NIST Secure Hash Algorithm
  55.  *     heavily modified by Uwe Hollerbach uh@alumni.caltech edu
  56.  *     from Peter C. Gutmann's implementation as found in
  57.  *     Applied Cryptography by Bruce Schneier
  58.  *     This code is hereby placed in the public domain
  59.  */
  60.  
  61. #ifndef APR_SHA1_H
  62. #define APR_SHA1_H
  63.  
  64. #include "apu.h"
  65. #include "apr_general.h"
  66.  
  67. #ifdef __cplusplus
  68. extern "C" {
  69. #endif
  70.  
  71. /**
  72.  * @file apr_sha1.h
  73.  * @brief APR-UTIL SHA1 library
  74.  */
  75.  
  76. /** size of the SHA1 DIGEST */
  77. #define APR_SHA1_DIGESTSIZE 20
  78.  
  79. /**
  80.  * Define the Magic String prefix that identifies a password as being
  81.  * hashed using our algorithm.
  82.  */
  83. #define APR_SHA1PW_ID "{SHA}"
  84.  
  85. /** length of the SHA Password */
  86. #define APR_SHA1PW_IDLEN 5
  87.  
  88. /**
  89.  * SHA1 context structure
  90.  */
  91. typedef struct apr_sha1_ctx_t apr_sha1_ctx_t;
  92.  
  93. struct apr_sha1_ctx_t {
  94.     /** message digest */
  95.     apr_uint32_t digest[5];
  96.     /** 64-bit bit counts */
  97.     apr_uint32_t count_lo, count_hi;
  98.     /** SHA data buffer */
  99.     apr_uint32_t data[16];
  100.     /** unprocessed amount in data */
  101.     int local;
  102. };
  103.  
  104. /**
  105.  * Provide a means to SHA1 crypt/encode a plaintext password in a way which
  106.  * makes password file compatible with those commonly use in netscape web
  107.  * and ldap installations.
  108.  * @param clear The plaintext password
  109.  * @param len The length of the plaintext password
  110.  * @param out The encrypted/encoded password
  111.  * @note SHA1 support is useful for migration purposes, but is less
  112.  *     secure than Apache's password format, since Apache's (MD5)
  113.  *     password format uses a random eight character salt to generate
  114.  *     one of many possible hashes for the same password.  Netscape
  115.  *     uses plain SHA1 without a salt, so the same password
  116.  *     will always generate the same hash, making it easier
  117.  *     to break since the search space is smaller.
  118.  */
  119. APU_DECLARE(void) apr_sha1_base64(const char *clear, int len, char *out);
  120.  
  121. /**
  122.  * Initialize the SHA digest
  123.  * @param context The SHA context to initialize
  124.  */
  125. APU_DECLARE(void) apr_sha1_init(apr_sha1_ctx_t *context);
  126.  
  127. /**
  128.  * Update the SHA digest
  129.  * @param context The SHA1 context to update
  130.  * @param input The buffer to add to the SHA digest
  131.  * @param inputLen The length of the input buffer
  132.  */
  133. APU_DECLARE(void) apr_sha1_update(apr_sha1_ctx_t *context, const char *input,
  134.                                 unsigned int inputLen);
  135.  
  136. /**
  137.  * Update the SHA digest with binary data
  138.  * @param context The SHA1 context to update
  139.  * @param input The buffer to add to the SHA digest
  140.  * @param inputLen The length of the input buffer
  141.  */
  142. APU_DECLARE(void) apr_sha1_update_binary(apr_sha1_ctx_t *context,
  143.                                        const unsigned char *input,
  144.                                        unsigned int inputLen);
  145.  
  146. /**
  147.  * Finish computing the SHA digest
  148.  * @param digest the output buffer in which to store the digest
  149.  * @param context The context to finalize
  150.  */
  151. APU_DECLARE(void) apr_sha1_final(unsigned char digest[APR_SHA1_DIGESTSIZE],
  152.                                apr_sha1_ctx_t *context);
  153.  
  154. #ifdef __cplusplus
  155. }
  156. #endif
  157.  
  158. #endif    /* APR_SHA1_H */
  159.